Entity EffectSpawn
EffectSpawn is the Entity definition for an effect spawner.
Subclass of Entity.
Functions
| GetSprite () | GetSprite returns the name of the sprite effect to use. |
| GetSequence () | GetSequence returns the effect emission sequence string. |
| GetLightAttach () | GetLightAttach returns the name of an attached light? |
| GetWavSound () | GetWavSound returns the name of a sound file for the effect. |
| GetRandomDelay () | GetRandomDelay returns an amount of random delay for the effect spawn. |
| IsOn () | IsOn returns true if the spawner is on. |
Functions
- GetSprite ()
-
GetSprite returns the name of the sprite effect to use.
Returns:
-
A string indicating the sprite file.
- GetSequence ()
-
GetSequence returns the effect emission sequence string.
Returns:
-
A string indicating the effect emission string.
- GetLightAttach ()
-
GetLightAttach returns the name of an attached light?
Returns:
-
A string indicating the attached light.
- GetWavSound ()
-
GetWavSound returns the name of a sound file for the effect.
Returns:
-
A string indicating the sound file to use.
- GetRandomDelay ()
-
GetRandomDelay returns an amount of random delay for the effect spawn.
Returns:
-
An integer indicating the random delay amount.
- IsOn ()
-
IsOn returns true if the spawner is on.
Returns:
-
A boolean indicating the spawner is on.